Skip to content

Allow env variable substitution in CLI client properties#242

Merged
tonygermano merged 1 commit intoOpenIntegrationEngine:mainfrom
VillePekka:issue-205
Feb 11, 2026
Merged

Allow env variable substitution in CLI client properties#242
tonygermano merged 1 commit intoOpenIntegrationEngine:mainfrom
VillePekka:issue-205

Conversation

@VillePekka
Copy link
Contributor

@VillePekka VillePekka commented Jan 19, 2026 •
edited by tonygermano
Loading

Testing the functionality on Linux:

  1. In mirth-cli-config.properties file, define for example password as password=${env:OIE_PASSWORD}
  2. Define the environment variable in commandline export OIE_PASSWORD=<password>
  3. Run cli client ~/engine/server/setup$ java -jar mirth-cli-launcher.jar -c ../../command/conf/mirth-cli-config.properties

@VillePekka VillePekka marked this pull request as draft January 19, 2026 18:38
@pacmano1 pacmano1 requested a review from Copilot January 20, 2026 02:20
Copilot AI reviewed Jan 20, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds environment variable substitution support to the CLI client properties file by replacing the standard Java Properties class with Apache Commons Configuration2's Configuration interface. This allows users to specify property values like password=${env:OIE_PASSWORD} in the configuration file, which will be resolved from environment variables at runtime.

Changes:

  • Replaced Properties with Apache Commons Configuration2's Configuration for loading CLI configuration
  • Added new imports for Configuration2 classes
  • Modified configuration loading logic to use FileBasedConfigurationBuilder instead of direct file reading

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@VillePekka
Copy link
Contributor Author

VillePekka commented Feb 1, 2026

Plan is to next test different scenarios with both correct and incorrect credentials:
*** Login with user and password given on the command line
*** Login with config file
**** with credentials directly in the file
**** with credentials as environment variables
**** with mistyped environment variable

@tonygermano tonygermano force-pushed the issue-205 branch 5 times, most recently from 2dc36ff to 4b8c71d Compare February 10, 2026 11:20
@VillePekka @tonygermano
Related to issue OpenIntegrationEngine#205. Enable using environment …
da0757e 
…variables in config file.

Signed-off-by: Ville Ranta-aho <ville@ville-pekka.com>
Signed-off-by: Tony Germano <tony@germano.name>
@tonygermano tonygermano marked this pull request as ready for review February 10, 2026 11:54
tonygermano
tonygermano approved these changes Feb 10, 2026
View reviewed changes
Copy link
Member

@tonygermano tonygermano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did the following:

  • squashed all commits
  • fixed whitespace issues
  • rebased onto main
  • removed some unnecessary imports
  • reverted copilot suggestion and initialized config to empty BaseConfiguration

I tested all of your scenarios mentioned in #242 (comment)

I also tested with no config file

  • no command line arguments (shows help)
  • setting -a -u and -p on the command line (logs in if everything is valid)
  • setting -a and -u, but not -p (shows help)

@tonygermano tonygermano linked an issue Feb 10, 2026 that may be closed by this pull request
[IDEA] Allow env variable substitution in CLI client properties #205
Closed
@tonygermano tonygermano requested review from a team, NicoPiel, gibson9583, jonbartels, kayyagari, mgaffigan, pacmano1 and ssrowe and removed request for a team February 10, 2026 12:15
mgaffigan
mgaffigan approved these changes Feb 11, 2026
View reviewed changes
Copy link
Contributor

@mgaffigan mgaffigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did not test, but the changes look good.

@tonygermano tonygermano merged commit da0757e into OpenIntegrationEngine:main Feb 11, 2026
2 checks passed
@VillePekka
Copy link
Contributor Author

VillePekka commented Feb 11, 2026

I did the following:

* squashed all commits

* fixed whitespace issues

* rebased onto main

* removed some unnecessary imports

* reverted copilot suggestion and initialized config to empty BaseConfiguration

I tested all of your scenarios mentioned in #242 (comment)

I also tested with no config file

* no command line arguments (shows help)

* setting -a -u and -p on the command line (logs in if everything is valid)

* setting -a and -u, but not -p (shows help)

Thank you @tonygermano !
Could you explain how you fixed whitespace issues, or give some pointer how to fix them in the future?
I tried with unix2dos command but that didn't seem to fix the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@gibson9583 gibson9583 gibson9583 approved these changes

@mgaffigan mgaffigan mgaffigan approved these changes

@tonygermano tonygermano tonygermano approved these changes

@pacmano1 pacmano1 pacmano1 approved these changes

@ssrowe ssrowe Awaiting requested review from ssrowe ssrowe was automatically assigned from OpenIntegrationEngine/maintainers

@jonbartels jonbartels Awaiting requested review from jonbartels jonbartels was automatically assigned from OpenIntegrationEngine/maintainers

@kayyagari kayyagari Awaiting requested review from kayyagari

@NicoPiel NicoPiel Awaiting requested review from NicoPiel

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[IDEA] Allow env variable substitution in CLI client properties

5 participants

@VillePekka @gibson9583 @mgaffigan @tonygermano @pacmano1